Skip to content

Make the markdownlint gate pass now that the action is allowed - #10636

Merged
Jakub Jareš (nohwnd) merged 1 commit into
mainfrom
nohwnd-fix-markdownlint-workflow
Aug 18, 2026
Merged

Make the markdownlint gate pass now that the action is allowed#10636
Jakub Jareš (nohwnd) merged 1 commit into
mainfrom
nohwnd-fix-markdownlint-workflow

Conversation

@nohwnd

Copy link
Copy Markdown
Member

The markdownlint gate ran for the first time since 2026-07-25 today, because DavidAnson/markdownlint-cli2-action is now permitted by the organization allowed-actions list. It starts, creates a job, and fails: 278 issues in 7 files. This makes it pass.

Why it was dead

The workflow ended in startup_failure on 435 consecutive runs. No job is created, so there is no check run and runs/<id>/logs returns 404 — the failure was invisible everywhere except the run page itself, which is why it went unnoticed for three weeks. The error, verbatim from run 31674560655:

The action DavidAnson/markdownlint-cli2-action@21c1be1 is not allowed in microsoft/testfx because all actions must be from a repository owned by your enterprise, created by GitHub, or match one of the patterns: DavidAnson/markdownlint-cli2-action@v18, dotnet/arcade/.github/workflows/*, peter-evans/create-pull-request@*.

The allow-list permitted the literal tag @v18 and nothing else. That matches the history exactly: #10163 bumped v18 to v24 and broke it, #10196 reverted to v18 as a side effect of an unrelated MSBuildCache change and it worked again, and #10214 re-bumped to v24.1.0 and broke it for good.

That cause is fixed outside this repository, so .github/workflows/markdownlint.yml is unchanged here and no Dependabot ignore is needed.

What this changes

Enabling the gate exposes 278 issues, 273 of them MD060/table-column-style — cosmetic pipe padding added in markdownlint v0.41 that no table in the repository follows. It is disabled in .markdownlint-cli2.jsonc next to the existing MD013 opt-out rather than reformatting 273 table cells across 6 RFCs. One or the other, not both.

The 5 genuine violations are fixed: MD004, MD022, MD032, MD038, and an MD051 link fragment that pointed at #granularity-guidance when the heading is ## Guidance (granularity).

Verified: markdownlint-cli2@0.23.2 reports 0 issues across 86 files, the same file count as before, and python .github/scripts/check_action_pins.py exits 0 across 2272 references.

🤖

Allowing DavidAnson/markdownlint-cli2-action in the organization
allowed-actions list lets the workflow start again after 435 consecutive
startup_failure runs. It now creates a job and immediately fails with 278
issues in 7 files.

273 of those are MD060/table-column-style, cosmetic pipe padding added in
markdownlint v0.41 that no table in the repository follows. Disable it
next to the existing MD013 opt-out rather than reformatting 273 table
cells across 6 RFCs.

Fix the 5 genuine violations: MD004, MD022, MD032, MD038, and an MD051
link fragment pointing at a heading that does not exist.

🤖

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Markdown lint configuration and resolves newly surfaced violations so the restored gate passes.

Changes:

  • Disables cosmetic MD060 table-padding enforcement.
  • Fixes heading spacing, list formatting, inline-code spacing, and a broken anchor.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
.markdownlint-cli2.jsonc Disables MD060.
docs/RFCs/016-JUnit-Report.md Fixes MD038.
docs/RFCs/017-TestHost-Launcher.md Fixes heading spacing.
docs/RFCs/020-Resource-Lock-Attribute.md Corrects the heading link fragment.
docs/RFCs/021-Per-Test-Temporary-Directory.md Fixes list formatting.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

🤖 Automated review by GitHub Copilot. Generated by the Expert Code Review workflow. To request a follow-up action, reply by tagging @copilot directly.

Expert Review Summary — Docs & Lint Config Only

Dimension Verdict
Correctness ✅ Pass
Documentation ✅ Pass
Style / Formatting ✅ Pass

Findings

No issues found. This is a low-risk, docs-only change. Verified highlights:

  1. RFC 020 anchor fix (#granularity-guidance#guidance-granularity): Confirmed correct. The target heading is ## Guidance (granularity), which GitHub renders as #guidance-granularity. The old link was broken.
  2. MD060 disable: Reasonable — the rule (cosmetic table-pipe padding) was added in markdownlint v0.41 and no existing table conforms. Disabling avoids mass churn.
  3. RFC 016 wording (`: ` → "colon-space separator"): Improves readability; avoids inline code that could confuse markdown renderers in some contexts.
  4. RFC 017 blank line after heading: Fixes MD022 (headings should be surrounded by blank lines).
  5. RFC 021 line rewrap: Pure formatting; no semantic change.

Verdict: LGTM — no blocking issues.

@nohwnd
Jakub Jareš (nohwnd) merged commit c80ea24 into main Aug 18, 2026
16 checks passed
@nohwnd
Jakub Jareš (nohwnd) deleted the nohwnd-fix-markdownlint-workflow branch August 18, 2026 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants